API docs by Redocly

3gpp-analyticsexposure (1.2.2)

Download OpenAPI specification:

API for Analytics Exposure.
© 2024, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

3GPP TS 29.522 V18.8.0; 5G System; Network Exposure Function Northbound APIs.

Analytics Exposure Subscriptions

read all of the active subscriptions for the AF

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
afId
required
string

Identifier of the AF

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features supported by the NF service consumer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new subscription resource

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
afId
required
string

Identifier of the AF

Request Body schema: application/json
required

new subscription creation

required
Array of objects (AnalyticsEventSubsc) non-empty
object (ReportingInformation)

Represents the type of reporting that the subscription requires.

notifUri
required
string (Uri)

string providing an URI formatted according to IETF RFC 3986.

notifId
required
string
Array of objects (AnalyticsEventNotif) non-empty
Array of objects (AnalyticsFailureEventInfo) non-empty
suppFeat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

self
string (Link)

string formatted according to IETF RFC 3986 identifying a referenced resource.

requestTestNotification
boolean

Set to true by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122. Set to false or omitted otherwise.

object (WebsockNotifConfig)

Represents the configuration information for the delivery of notifications over Websockets.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "analyEventsSubs": [
    ],
  • "analyRepInfo": {
    },
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifis": [
    ],
  • "failEventReports": [
    ],
  • "suppFeat": "string",
  • "self": "string",
  • "requestTestNotification": true,
  • "websockNotifConfig": {
    }
}

Response samples

Content type
application/json
{
  • "analyEventsSubs": [
    ],
  • "analyRepInfo": {
    },
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifis": [
    ],
  • "failEventReports": [
    ],
  • "suppFeat": "string",
  • "self": "string",
  • "requestTestNotification": true,
  • "websockNotifConfig": {
    }
}

Callback payload samples

Callback
POST: {$request.body#/notifUri}
Content type
application/json
{
  • "notifId": "string",
  • "analyEventNotifs": [
    ],
  • "termCause": "USER_CONSENT_REVOKED"
}

Individual Analytics Exposure Subscription

read an active subscription for the AF and the subscription Id

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
afId
required
string

Identifier of the AF

subscriptionId
required
string

Identifier of the subscription resource

query Parameters
supp-feat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

Features supported by the NF service consumer

Responses

Response samples

Content type
application/json
{
  • "analyEventsSubs": [
    ],
  • "analyRepInfo": {
    },
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifis": [
    ],
  • "failEventReports": [
    ],
  • "suppFeat": "string",
  • "self": "string",
  • "requestTestNotification": true,
  • "websockNotifConfig": {
    }
}

Fully updates/replaces an existing subscription resource

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
afId
required
string

Identifier of the AF

subscriptionId
required
string

Identifier of the subscription resource

Request Body schema: application/json
required

Parameters to update/replace the existing subscription

required
Array of objects (AnalyticsEventSubsc) non-empty
object (ReportingInformation)

Represents the type of reporting that the subscription requires.

notifUri
required
string (Uri)

string providing an URI formatted according to IETF RFC 3986.

notifId
required
string
Array of objects (AnalyticsEventNotif) non-empty
Array of objects (AnalyticsFailureEventInfo) non-empty
suppFeat
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

self
string (Link)

string formatted according to IETF RFC 3986 identifying a referenced resource.

requestTestNotification
boolean

Set to true by the AF to request the NEF to send a test notification as defined in clause 5.2.5.3 of 3GPP TS 29.122. Set to false or omitted otherwise.

object (WebsockNotifConfig)

Represents the configuration information for the delivery of notifications over Websockets.

Responses

Request samples

Content type
application/json
{
  • "analyEventsSubs": [
    ],
  • "analyRepInfo": {
    },
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifis": [
    ],
  • "failEventReports": [
    ],
  • "suppFeat": "string",
  • "self": "string",
  • "requestTestNotification": true,
  • "websockNotifConfig": {
    }
}

Response samples

Content type
application/json
{
  • "analyEventsSubs": [
    ],
  • "analyRepInfo": {
    },
  • "notifUri": "string",
  • "notifId": "string",
  • "eventNotifis": [
    ],
  • "failEventReports": [
    ],
  • "suppFeat": "string",
  • "self": "string",
  • "requestTestNotification": true,
  • "websockNotifConfig": {
    }
}

Deletes an already existing subscription

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
afId
required
string

Identifier of the AF

subscriptionId
required
string

Identifier of the subscription resource

Responses

Response samples

Content type
application/problem+json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "cause": "string",
  • "invalidParams": [
    ],
  • "supportedFeatures": "string"
}

AnalyticsExposure API Fetch analytics information

Fetch analytics information

Authorizations:
NoneoAuth2ClientCredentials
path Parameters
afId
required
string

Identifier of the AF

Request Body schema: application/json
required
required
string or string (AnalyticsEvent)

Represents the analytics event that is subscribed or notified.
Possible values are:

  • UE_MOBILITY: The AF requests to be notified about analytics information of UE mobility.
  • UE_COMM: The AF requests to be notified about analytics information of UE communication.
  • ABNORMAL_BEHAVIOR: The AF requests to be notified about analytics information of UE's abnormal behavior.
  • CONGESTION: The AF requests to be notified about analytics information of user data congestion information.
  • NETWORK_PERFORMANCE: The AF requests to be notified about analytics information of network performance.
  • QOS_SUSTAINABILITY: The AF requests to be notified about analytics information of QoS sustainability.
  • DISPERSION: The AF requests to be notified about analytics information of Dispersion analytics.
  • DN_PERFORMANCE: The AF requests to be notified about analytics information of DN performance.
  • SERVICE_EXPERIENCE: The AF requests to be notified about analytics information of service experience.
  • E2E_DATA_VOL_TRANS_TIME: The AF requests to be notified about analytics information of E2E data volume transfer time.
  • MOVEMENT_BEHAVIOUR: The AF requests to be notified about analytics information of Movement Behaviour.
  • RELATIVE_PROXIMITY: The AF requests to be notified about analytics information of Relative Proximity.
  • WLAN_PERFORMANCE: Indicates that the event subscribed is the Wlan Performance information.
  • NS_LOAD_LEVEL: Indicates that the event subscribed is load level information of Network Slice.
object (AnalyticsEventFilter)

Represents analytics event filter information.

object (EventReportingRequirement)

Represents the type of reporting that the subscription requires.

object (TargetUeId)

Represents the target UE(s) information.

suppFeat
required
string (SupportedFeatures) ^[A-Fa-f0-9]*$

A string used to indicate the features supported by an API that is used as defined in clause 6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in hexadecimal representation Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in table 5.2.2-3. The most significant character representing the highest-numbered features shall appear first in the string, and the character representing features 1 to 4 shall appear last in the string. The list of features and their numbering (starting with 1) are defined separately for each API. If the string contains a lower number of characters than there are defined features for an API, all features that would be represented by characters that are not present in the string are not supported.

Responses

Request samples

Content type
application/json
{
  • "analyEvent": "UE_MOBILITY",
  • "analyEventFilter": {
    },
  • "analyRep": {
    },
  • "tgtUe": {
    },
  • "suppFeat": "string"
}

Response samples

Content type
application/json
{
  • "start": "2019-08-24T14:15:22Z",
  • "expiry": "2019-08-24T14:15:22Z",
  • "timeStampGen": "2019-08-24T14:15:22Z",
  • "ueMobilityInfos": [
    ],
  • "ueCommInfos": [
    ],
  • "nwPerfInfos": [
    ],
  • "abnormalInfos": [
    ],
  • "congestInfos": [
    ],
  • "dataVlTrnsTmInfos": [
    ],
  • "qosSustainInfos": [
    ],
  • "disperInfos": [
    ],
  • "dnPerfInfos": [
    ],
  • "svcExps": [
    ],
  • "disperReqs": [
    ],
  • "movBehavInfos": [
    ],
  • "wlanInfos": [
    ],
  • "accuInfo": {
    },
  • "cancelAccuInd": true,
  • "relProxInfos": [
    ],
  • "suppFeat": "string"
}